grade-school: Expect Option<Vec<String>> from grade; add stub file
#256
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, grade was expected to return an `Option<&Vec<String>>`. Because there's a reference inside the lifetime, any implementing School would have been required to maintain ownership of some vectors so that they can be lended out. This unnecessarily restricts the implementation. For example, some implementations may instead have preferred to use BTreeSet. If we expect grade to return `Option<Vec<String>>`, the fact that ownership is given means that a new vector can be made from whatever internal representation is used. Closes #254.
petertseng
changed the title
Option<Vec<String>> from gradeOption<Vec<String>> from grade; add stub file
|
Thanks! That makes more sense now! :) |
petertseng
commented
Feb 3, 2017
| unimplemented!() | ||
| } | ||
|
|
||
| pub fn grade(&self, grade: u32) -> Option<Vec<String>> { |
There was a problem hiding this comment.
It would be nice if, when a constraining choice like this is made, the README or stub file could be explicit about why that interface was chosen.
I failed to do this. It could be something like "If grade returned an Option<&Vec<String>>, the internal implementation would be forced to keep a Vec<String> to lend out. By returning an owned vector instead, the internal implementation is free to use whatever it chooses." This is your chance to suggest whether this text should be added as a comment, or something else.
|
Ten days, one definite vote that this improves things, and no objections. I'm merging it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, grade was expected to return an
Option<&Vec<String>>.Because there's a reference inside the lifetime, any implementing School
would have been required to maintain ownership of some vectors so that
they can be lended out. This unnecessarily restricts the implementation.
For example, some implementations may instead have preferred to use
BTreeSet.
If we expect grade to return
Option<Vec<String>>, the fact thatownership is given means that a new vector can be made from whatever
internal representation is used.
Closes #254.